Cisco-IOS-XR-mpls-ldp-cfg API API Reference
API generated from Cisco-IOS-XR-mpls-ldp-cfg@2017-09-30.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key  Mandatory  OptionalPaths
MPLS-LDP - Update
Update operation of resource: mpls-ldp
mpls-ldpbody object
Request Content-Types: application/json
Request Example
{ "enable": "null", Enable Address Family "enable": "null" Enable Address Family
}, "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}, "enable": "null", Enable Address Family {
"vrf-name": "string", VRF Name
"enable": "null", Enable Address Family {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable Address Family {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}, "enable": "null" Enable Address Family
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}
}
]
}
}
]
}, "notifications": "null" MPLS mLDP logging notifications
}
}, {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable Address Family {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}, "enable": "null" Enable Address Family
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}
}
]
}
}
}, "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
},
"ltrace-buf-multiplier": "integer", Configure Ltrace Buffer Multiplier
range: "1..5"
default: "1" "hold-time": "integer", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180" "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
},
"disable-implicit-ipv4": "null", Disable the implicit enabling for IPv4 address\nfamily "dscp": "string" DSCP for control packets
}, "nsr": "null", Configure LDP Non-Stop Routing
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}, "enable": "null" Enable Address Family
}, "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", Enable Address Family
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}, { "disable": "null", Disable label advertisement
"timeout": "integer" Time (seconds)
range: "1..600000"
units: "second"
}
}
}
}, "disable-quick-start": "null", Disable discovery's quick start mode "dual-stack": "string", Configuration related to neighbor transport
"interval": "string", Link Hello interval
units: "minute"
"hold-time": "string" Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
}
}
},
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "disable": "null" Disable label advertisement
}, "address-type": "string", Transport address option
"address": "string" IP address
}
}, "disable-auto-config": "null" Disable IGP Auto-config on this interface
}
}
]
}
}
]
}, "peer-acl-name": "string", Name of peer ACL
"type": "string" Downstream on demand type
}, "peer-acl-name": "string", Name of peer ACL
"protection-type": "string", Session protection type
"duration": "integer" Holdup duration
range: "30..2147483"
}
},
"router-id": "string", Configuration for LDP Router ID (LDP ID) "password": "string", The neighbor password "tlv-compliance": "null", Configuration to enable neighbor dual-stack\ntlv-compliance "max-wait": "integer", Configuration related to neighbor\ndual-stack xport-connection max-wait
range: "0..60"
units: "second" "ipv4": "null" Configuration related to neighbor\ndual-stack xport-connection preference\nipv4
}
}
}, {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}, "maintain-on-local-reset": "string" Maintain the state of a GR peer upon a\nlocal reset
}
}
}, {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family {
"targeted": "null", Establish targeted session with given\naddress
"ip-address": "string" The IP address
}
]
}
}, "group-all": "null", Enable all MPLS TE auto-tunnel mesh-group\ninterfaces {
"mesh-group-id": "string" Mesh group ID
}
]
}
}
}, "transport-address": "string", Global discovery transport address for\naddress family "peer-acl-name": "string", Name of peer ACL
"accept-type": "string" Type of acceptance
}
}, "as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero\nvalue if second half is zero.
range: "0..65535"
"as-yy": "integer" Second half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero value\nif first half is zero.
range: "0..4294967295"
}, "peer-acl-name": "string", Name of peer ACL
"type": "string" Downstream on demand type
}
}
}, {
"peer-acl-name": "string", Name of peer ACL
"prefix-acl-name": "string", Name of prefix ACL
"advertise-type": "string" Label advertise type
}
]
},
"disable": "null", Disable label advertisement {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string", Name of prefix ACL
"label-space-id": "integer" Label space ID of neighbor
}
]
}, {
"interface-name": "string" Name of interface
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}, {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string", Name of prefix ACL
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
}
]
}
}, { {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}, "peer-acl-name": "string", Name of peer ACL
"type": "string" Downstream on demand type
}
},
"router-id": "string", Configuration for LDP Router ID (LDP ID) "password": "string", The neighbor password {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}, "maintain-on-local-reset": "string" Maintain the state of a GR peer upon a\nlocal reset
}
}
},
"vrf-name": "string", VRF Name
"enable": "null", Enable Address Family {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "transport-address": "string" Global discovery transport address for\naddress family
}, {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}, { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
}
]
}
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LDP - Create
Create operation of resource: mpls-ldp
mpls-ldpbody object
Request Content-Types: application/json
Request Example
{ "enable": "null", Enable Address Family "enable": "null" Enable Address Family
}, "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}, "enable": "null", Enable Address Family {
"vrf-name": "string", VRF Name
"enable": "null", Enable Address Family {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable Address Family {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}, "enable": "null" Enable Address Family
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}
}
]
}
}
]
}, "notifications": "null" MPLS mLDP logging notifications
}
}, {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable Address Family {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}, "enable": "null" Enable Address Family
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}
}
]
}
}
}, "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
},
"ltrace-buf-multiplier": "integer", Configure Ltrace Buffer Multiplier
range: "1..5"
default: "1" "hold-time": "integer", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180" "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
},
"disable-implicit-ipv4": "null", Disable the implicit enabling for IPv4 address\nfamily "dscp": "string" DSCP for control packets
}, "nsr": "null", Configure LDP Non-Stop Routing
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}, "enable": "null" Enable Address Family
}, "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", Enable Address Family
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}, { "disable": "null", Disable label advertisement
"timeout": "integer" Time (seconds)
range: "1..600000"
units: "second"
}
}
}
}, "disable-quick-start": "null", Disable discovery's quick start mode "dual-stack": "string", Configuration related to neighbor transport
"interval": "string", Link Hello interval
units: "minute"
"hold-time": "string" Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
}
}
},
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "disable": "null" Disable label advertisement
}, "address-type": "string", Transport address option
"address": "string" IP address
}
}, "disable-auto-config": "null" Disable IGP Auto-config on this interface
}
}
]
}
}
]
}, "peer-acl-name": "string", Name of peer ACL
"type": "string" Downstream on demand type
}, "peer-acl-name": "string", Name of peer ACL
"protection-type": "string", Session protection type
"duration": "integer" Holdup duration
range: "30..2147483"
}
},
"router-id": "string", Configuration for LDP Router ID (LDP ID) "password": "string", The neighbor password "tlv-compliance": "null", Configuration to enable neighbor dual-stack\ntlv-compliance "max-wait": "integer", Configuration related to neighbor\ndual-stack xport-connection max-wait
range: "0..60"
units: "second" "ipv4": "null" Configuration related to neighbor\ndual-stack xport-connection preference\nipv4
}
}
}, {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}, "maintain-on-local-reset": "string" Maintain the state of a GR peer upon a\nlocal reset
}
}
}, {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family {
"targeted": "null", Establish targeted session with given\naddress
"ip-address": "string" The IP address
}
]
}
}, "group-all": "null", Enable all MPLS TE auto-tunnel mesh-group\ninterfaces {
"mesh-group-id": "string" Mesh group ID
}
]
}
}
}, "transport-address": "string", Global discovery transport address for\naddress family "peer-acl-name": "string", Name of peer ACL
"accept-type": "string" Type of acceptance
}
}, "as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero\nvalue if second half is zero.
range: "0..65535"
"as-yy": "integer" Second half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero value\nif first half is zero.
range: "0..4294967295"
}, "peer-acl-name": "string", Name of peer ACL
"type": "string" Downstream on demand type
}
}
}, {
"peer-acl-name": "string", Name of peer ACL
"prefix-acl-name": "string", Name of prefix ACL
"advertise-type": "string" Label advertise type
}
]
},
"disable": "null", Disable label advertisement {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string", Name of prefix ACL
"label-space-id": "integer" Label space ID of neighbor
}
]
}, {
"interface-name": "string" Name of interface
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}, {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string", Name of prefix ACL
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
}
]
}
}, { {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}, "peer-acl-name": "string", Name of peer ACL
"type": "string" Downstream on demand type
}
},
"router-id": "string", Configuration for LDP Router ID (LDP ID) "password": "string", The neighbor password {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}, "maintain-on-local-reset": "string" Maintain the state of a GR peer upon a\nlocal reset
}
}
},
"vrf-name": "string", VRF Name
"enable": "null", Enable Address Family {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "transport-address": "string" Global discovery transport address for\naddress family
}, {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}, { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
}
]
}
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LDP - Delete
Delete operation of resource: mpls-ldp
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LDP - Retrieve
Retrieve operation of resource: mpls-ldp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "null", Enable Address Family "enable": "null" Enable Address Family
}, "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}, "enable": "null", Enable Address Family {
"vrf-name": "string", VRF Name
"enable": "null", Enable Address Family {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable Address Family {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}, "enable": "null" Enable Address Family
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}
}
]
}
}
]
}, "notifications": "null" MPLS mLDP logging notifications
}
}, {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable Address Family {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}, "enable": "null" Enable Address Family
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}, "policy": "string", Route policy name
"enable": "null" Enable Address Family
}
}
]
}
}
}, "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
},
"ltrace-buf-multiplier": "integer", Configure Ltrace Buffer Multiplier
range: "1..5"
default: "1" "hold-time": "integer", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180" "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
},
"disable-implicit-ipv4": "null", Disable the implicit enabling for IPv4 address\nfamily "dscp": "string" DSCP for control packets
}, "nsr": "null", Configure LDP Non-Stop Routing
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}, "enable": "null" Enable Address Family
}, "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", Enable Address Family
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}, { "disable": "null", Disable label advertisement
"timeout": "integer" Time (seconds)
range: "1..600000"
units: "second"
}
}
}
}, "disable-quick-start": "null", Disable discovery's quick start mode "dual-stack": "string", Configuration related to neighbor transport
"interval": "string", Link Hello interval
units: "minute"
"hold-time": "string" Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
}
}
},
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "disable": "null" Disable label advertisement
}, "address-type": "string", Transport address option
"address": "string" IP address
}
}, "disable-auto-config": "null" Disable IGP Auto-config on this interface
}
}
]
}
}
]
}, "peer-acl-name": "string", Name of peer ACL
"type": "string" Downstream on demand type
}, "peer-acl-name": "string", Name of peer ACL
"protection-type": "string", Session protection type
"duration": "integer" Holdup duration
range: "30..2147483"
}
},
"router-id": "string", Configuration for LDP Router ID (LDP ID) "password": "string", The neighbor password "tlv-compliance": "null", Configuration to enable neighbor dual-stack\ntlv-compliance "max-wait": "integer", Configuration related to neighbor\ndual-stack xport-connection max-wait
range: "0..60"
units: "second" "ipv4": "null" Configuration related to neighbor\ndual-stack xport-connection preference\nipv4
}
}
}, {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}, "maintain-on-local-reset": "string" Maintain the state of a GR peer upon a\nlocal reset
}
}
}, {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family {
"targeted": "null", Establish targeted session with given\naddress
"ip-address": "string" The IP address
}
]
}
}, "group-all": "null", Enable all MPLS TE auto-tunnel mesh-group\ninterfaces {
"mesh-group-id": "string" Mesh group ID
}
]
}
}
}, "transport-address": "string", Global discovery transport address for\naddress family "peer-acl-name": "string", Name of peer ACL
"accept-type": "string" Type of acceptance
}
}, "as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero\nvalue if second half is zero.
range: "0..65535"
"as-yy": "integer" Second half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero value\nif first half is zero.
range: "0..4294967295"
}, "peer-acl-name": "string", Name of peer ACL
"type": "string" Downstream on demand type
}
}
}, {
"peer-acl-name": "string", Name of peer ACL
"prefix-acl-name": "string", Name of prefix ACL
"advertise-type": "string" Label advertise type
}
]
},
"disable": "null", Disable label advertisement {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string", Name of prefix ACL
"label-space-id": "integer" Label space ID of neighbor
}
]
}, {
"interface-name": "string" Name of interface
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}, {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string", Name of prefix ACL
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
}
]
}
}, { {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}, "peer-acl-name": "string", Name of peer ACL
"type": "string" Downstream on demand type
}
},
"router-id": "string", Configuration for LDP Router ID (LDP ID) "password": "string", The neighbor password {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}, "maintain-on-local-reset": "string" Maintain the state of a GR peer upon a\nlocal reset
}
}
},
"vrf-name": "string", VRF Name
"enable": "null", Enable Address Family {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "transport-address": "string" Global discovery transport address for\naddress family
}, {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}, { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
}
]
}
}
]
}
}
}
DEFAULT-VRF - Update
Update operation of resource: default-vrf
default-vrfbody object
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Create
Create operation of resource: default-vrf
default-vrfbody object
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Delete
Delete operation of resource: default-vrf
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Retrieve
Retrieve operation of resource: default-vrf
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
}
AFS - Update
Update operation of resource: afs
afsbody object
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
AF - Update
Update operation of resource: af
afbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
LABEL - Update
Update operation of resource: label
labelbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}, { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LABEL - Create
Create operation of resource: label
labelbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}, { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LABEL - Delete
Delete operation of resource: label
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
LABEL - Retrieve
Retrieve operation of resource: label
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}, { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
}
REMOTE - Update
Update operation of resource: remote
remotebody object
ID of af-name
Request Content-Types: application/json
Request Example
{ { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Create
Create operation of resource: remote
remotebody object
ID of af-name
Request Content-Types: application/json
Request Example
{ { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Delete
Delete operation of resource: remote
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Retrieve
Retrieve operation of resource: remote
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
ACCEPT - Update
Update operation of resource: accept
acceptbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ACCEPT - Create
Create operation of resource: accept
acceptbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ACCEPT - Delete
Delete operation of resource: accept
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ACCEPT - Retrieve
Retrieve operation of resource: accept
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
PEER-ACCEPT-POLICIES - Update
Update operation of resource: peer-accept-policies
peer-accept-policiesbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICIES - Create
Create operation of resource: peer-accept-policies
peer-accept-policiesbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICIES - Delete
Delete operation of resource: peer-accept-policies
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICIES - Retrieve
Retrieve operation of resource: peer-accept-policies
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
PEER-ACCEPT-POLICY - Update
Update operation of resource: peer-accept-policy
peer-accept-policybody object
ID of af-name
ID of lsr-id label-space-id
Request Content-Types: application/json
Request Example
{ : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY - Create
Create operation of resource: peer-accept-policy
peer-accept-policybody object
ID of af-name
ID of lsr-id label-space-id
Request Content-Types: application/json
Request Example
{ : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY - Delete
Delete operation of resource: peer-accept-policy
ID of af-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY - Retrieve
Retrieve operation of resource: peer-accept-policy
ID of af-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
}
LOCAL - Update
Update operation of resource: local
localbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL - Create
Create operation of resource: local
localbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL - Delete
Delete operation of resource: local
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL - Retrieve
Retrieve operation of resource: local
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}
}
ADVERTISE - Update
Update operation of resource: advertise
advertisebody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE - Create
Create operation of resource: advertise
advertisebody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE - Delete
Delete operation of resource: advertise
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE - Retrieve
Retrieve operation of resource: advertise
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
}
}
PEER-ADVERTISE-POLICIES - Update
Update operation of resource: peer-advertise-policies
peer-advertise-policiesbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICIES - Create
Create operation of resource: peer-advertise-policies
peer-advertise-policiesbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICIES - Delete
Delete operation of resource: peer-advertise-policies
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICIES - Retrieve
Retrieve operation of resource: peer-advertise-policies
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
PEER-ADVERTISE-POLICY - Update
Update operation of resource: peer-advertise-policy
peer-advertise-policybody object
ID of af-name
ID of lsr-id label-space-id
Request Content-Types: application/json
Request Example
{ : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY - Create
Create operation of resource: peer-advertise-policy
peer-advertise-policybody object
ID of af-name
ID of lsr-id label-space-id
Request Content-Types: application/json
Request Example
{ : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY - Delete
Delete operation of resource: peer-advertise-policy
ID of af-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY - Retrieve
Retrieve operation of resource: peer-advertise-policy
ID of af-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : [LSR ID of neighbor {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], : {Data container. "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
}
PREFIX-ADVERTISE-POLICIES - Update
Update operation of resource: prefix-advertise-policies
prefix-advertise-policiesbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"peer-acl-name": "string", Name of peer ACL
"prefix-acl-name": "string", Name of prefix ACL
"advertise-type": "string" Label advertise type
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PREFIX-ADVERTISE-POLICIES - Create
Create operation of resource: prefix-advertise-policies
prefix-advertise-policiesbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"peer-acl-name": "string", Name of peer ACL
"prefix-acl-name": "string", Name of prefix ACL
"advertise-type": "string" Label advertise type
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PREFIX-ADVERTISE-POLICIES - Delete
Delete operation of resource: prefix-advertise-policies
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PREFIX-ADVERTISE-POLICIES - Retrieve
Retrieve operation of resource: prefix-advertise-policies
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"peer-acl-name": "string", Name of peer ACL
"prefix-acl-name": "string", Name of prefix ACL
"advertise-type": "string" Label advertise type
}
]
}
}
PREFIX-ADVERTISE-POLICY - Update
Update operation of resource: prefix-advertise-policy
prefix-advertise-policybody object
ID of af-name
ID of prefix-acl-name
Successful operation
Internal Error
Response Content-Types: application/json
PREFIX-ADVERTISE-POLICY - Create
Create operation of resource: prefix-advertise-policy
prefix-advertise-policybody object
ID of af-name
ID of prefix-acl-name
Successful operation
Internal Error
Response Content-Types: application/json
PREFIX-ADVERTISE-POLICY - Delete
Delete operation of resource: prefix-advertise-policy
ID of af-name
ID of prefix-acl-name
Successful operation
Internal Error
Response Content-Types: application/json
PREFIX-ADVERTISE-POLICY - Retrieve
Retrieve operation of resource: prefix-advertise-policy
ID of af-name
ID of prefix-acl-name
Successful operation
Internal Error
EXPLICIT-NULL - Update
Update operation of resource: explicit-null
explicit-nullbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-NULL - Create
Create operation of resource: explicit-null
explicit-nullbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-NULL - Delete
Delete operation of resource: explicit-null
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-NULL - Retrieve
Retrieve operation of resource: explicit-null
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface : {Address Family specific configuration for\nMPLS LDP vrf intf : [No description {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family : {Configure interface discovery parameters : {MPLS LDP configuration for interface\ndiscovery transportaddress. "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface : {Address Family specific configuration for\nMPLS LDP vrf intf : [No description {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family : {Configure interface discovery parameters : {MPLS LDP configuration for interface\ndiscovery transportaddress. "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface : {Address Family specific configuration for\nMPLS LDP vrf intf : [No description {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family : {Configure interface discovery parameters : {MPLS LDP configuration for interface\ndiscovery transportaddress. "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of af-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface : {Address Family specific configuration for\nMPLS LDP vrf intf : [No description {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family : {Configure interface discovery parameters : {MPLS LDP configuration for interface\ndiscovery transportaddress. "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of af-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface : {Address Family specific configuration for\nMPLS LDP vrf intf : [No description {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family : {Configure interface discovery parameters : {MPLS LDP configuration for interface\ndiscovery transportaddress. "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of af-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of af-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface : {Address Family specific configuration for\nMPLS LDP vrf intf : [No description {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family : {Configure interface discovery parameters : {MPLS LDP configuration for interface\ndiscovery transportaddress. "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
ALLOCATE - Update
Update operation of resource: allocate
allocatebody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ALLOCATE - Create
Create operation of resource: allocate
allocatebody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ALLOCATE - Delete
Delete operation of resource: allocate
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ALLOCATE - Retrieve
Retrieve operation of resource: allocate
ID of af-name
Successful operation
Internal Error
DISCOVERY - Update
Update operation of resource: discovery
discoverybody object
ID of af-name
Request Content-Types: application/json
Request Example
{ : {LDP Targeted Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Create
Create operation of resource: discovery
discoverybody object
ID of af-name
Request Content-Types: application/json
Request Example
{ : {LDP Targeted Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Delete
Delete operation of resource: discovery
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {LDP Targeted Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
TARGETED-HELLO-ACCEPT - Update
Update operation of resource: targeted-hello-accept
targeted-hello-acceptbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGETED-HELLO-ACCEPT - Create
Create operation of resource: targeted-hello-accept
targeted-hello-acceptbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGETED-HELLO-ACCEPT - Delete
Delete operation of resource: targeted-hello-accept
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGETED-HELLO-ACCEPT - Retrieve
Retrieve operation of resource: targeted-hello-accept
ID of af-name
Successful operation
Internal Error
TRAFFIC-ENGINEERING - Update
Update operation of resource: traffic-engineering
traffic-engineeringbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ "group-all": "null", Enable all MPLS TE auto-tunnel mesh-group\ninterfaces {
"mesh-group-id": "string" Mesh group ID
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Create
Create operation of resource: traffic-engineering
traffic-engineeringbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ "group-all": "null", Enable all MPLS TE auto-tunnel mesh-group\ninterfaces {
"mesh-group-id": "string" Mesh group ID
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Delete
Delete operation of resource: traffic-engineering
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Retrieve
Retrieve operation of resource: traffic-engineering
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-all": "null", Enable all MPLS TE auto-tunnel mesh-group\ninterfaces {
"mesh-group-id": "string" Mesh group ID
}
]
}
}
}
}
AUTO-TUNNEL-MESH - Update
Update operation of resource: auto-tunnel-mesh
auto-tunnel-meshbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ "group-all": "null", Enable all MPLS TE auto-tunnel mesh-group\ninterfaces {
"mesh-group-id": "string" Mesh group ID
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-TUNNEL-MESH - Create
Create operation of resource: auto-tunnel-mesh
auto-tunnel-meshbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ "group-all": "null", Enable all MPLS TE auto-tunnel mesh-group\ninterfaces {
"mesh-group-id": "string" Mesh group ID
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-TUNNEL-MESH - Delete
Delete operation of resource: auto-tunnel-mesh
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-TUNNEL-MESH - Retrieve
Retrieve operation of resource: auto-tunnel-mesh
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-all": "null", Enable all MPLS TE auto-tunnel mesh-group\ninterfaces {
"mesh-group-id": "string" Mesh group ID
}
]
}
}
}
GROUP-IDS - Update
Update operation of resource: group-ids
group-idsbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-IDS - Create
Create operation of resource: group-ids
group-idsbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-IDS - Delete
Delete operation of resource: group-ids
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-IDS - Retrieve
Retrieve operation of resource: group-ids
ID of af-name
Successful operation
Internal Error
GROUP-ID - Update
Update operation of resource: group-id
group-idbody object
ID of af-name
ID of mesh-group-id
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-ID - Create
Create operation of resource: group-id
group-idbody object
ID of af-name
ID of mesh-group-id
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-ID - Delete
Delete operation of resource: group-id
ID of af-name
ID of mesh-group-id
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-ID - Retrieve
Retrieve operation of resource: group-id
ID of af-name
ID of mesh-group-id
Successful operation
Internal Error
NEIGHBOR - Update
Update operation of resource: neighbor
neighborbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ "password": "string", The neighbor password : {Configuration related to Neighbors using LDP\nId : [No description {
"lsr-id": "string", LSR ID of neighbor : {The neighbor password "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Create
Create operation of resource: neighbor
neighborbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ "password": "string", The neighbor password : {Configuration related to Neighbors using LDP\nId : [No description {
"lsr-id": "string", LSR ID of neighbor : {The neighbor password "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Delete
Delete operation of resource: neighbor
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "password": "string", The neighbor password : {Configuration related to Neighbors using LDP\nId : [No description {
"lsr-id": "string", LSR ID of neighbor : {The neighbor password "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
ADDRESSES - Update
Update operation of resource: addresses
addressesbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESSES - Create
Create operation of resource: addresses
addressesbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESSES - Delete
Delete operation of resource: addresses
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESSES - Retrieve
Retrieve operation of resource: addresses
ID of af-name
Successful operation
Internal Error
ADDRESS - Update
Update operation of resource: address
addressbody object
ID of af-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESS - Create
Create operation of resource: address
addressbody object
ID of af-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESS - Delete
Delete operation of resource: address
ID of af-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESS - Retrieve
Retrieve operation of resource: address
ID of af-name
ID of ip-address
Successful operation
Internal Error
REDISTRIBUTION-PROTOCOL - Update
Update operation of resource: redistribution-protocol
redistribution-protocolbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero\nvalue if second half is zero.
range: "0..65535"
"as-yy": "integer" Second half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero value\nif first half is zero.
range: "0..4294967295"
}, "peer-acl-name": "string", Name of peer ACL
"type": "string" advertise to peer acl type
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTION-PROTOCOL - Create
Create operation of resource: redistribution-protocol
redistribution-protocolbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero\nvalue if second half is zero.
range: "0..65535"
"as-yy": "integer" Second half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero value\nif first half is zero.
range: "0..4294967295"
}, "peer-acl-name": "string", Name of peer ACL
"type": "string" advertise to peer acl type
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTION-PROTOCOL - Delete
Delete operation of resource: redistribution-protocol
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTION-PROTOCOL - Retrieve
Retrieve operation of resource: redistribution-protocol
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero\nvalue if second half is zero.
range: "0..65535"
"as-yy": "integer" Second half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero value\nif first half is zero.
range: "0..4294967295"
}, "peer-acl-name": "string", Name of peer ACL
"type": "string" advertise to peer acl type
}
}
}
}
BGP - Update
Update operation of resource: bgp
bgpbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero\nvalue if second half is zero.
range: "0..65535"
"as-yy": "integer" Second half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero value\nif first half is zero.
range: "0..4294967295"
}, "peer-acl-name": "string", Name of peer ACL
"type": "string" advertise to peer acl type
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Create
Create operation of resource: bgp
bgpbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero\nvalue if second half is zero.
range: "0..65535"
"as-yy": "integer" Second half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero value\nif first half is zero.
range: "0..4294967295"
}, "peer-acl-name": "string", Name of peer ACL
"type": "string" advertise to peer acl type
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Delete
Delete operation of resource: bgp
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Retrieve
Retrieve operation of resource: bgp
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero\nvalue if second half is zero.
range: "0..65535"
"as-yy": "integer" Second half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero value\nif first half is zero.
range: "0..4294967295"
}, "peer-acl-name": "string", Name of peer ACL
"type": "string" advertise to peer acl type
}
}
}
AS - Update
Update operation of resource: as
asbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero\nvalue if second half is zero.
range: "0..65535"
"as-yy": "integer" Second half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero value\nif first half is zero.
range: "0..4294967295"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AS - Create
Create operation of resource: as
asbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero\nvalue if second half is zero.
range: "0..65535"
"as-yy": "integer" Second half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero value\nif first half is zero.
range: "0..4294967295"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AS - Delete
Delete operation of resource: as
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AS - Retrieve
Retrieve operation of resource: as
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero\nvalue if second half is zero.
range: "0..65535"
"as-yy": "integer" Second half of BGP AS number in XX.YY\nformat. Mandatory Must be a non-zero value\nif first half is zero.
range: "0..4294967295"
}
}
ADVERTISE-TO - Update
Update operation of resource: advertise-to
advertise-tobody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE-TO - Create
Create operation of resource: advertise-to
advertise-tobody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE-TO - Delete
Delete operation of resource: advertise-to
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE-TO - Retrieve
Retrieve operation of resource: advertise-to
ID of af-name
Successful operation
Internal Error
GLOBAL - Update
Update operation of resource: global
globalbody object
Request Content-Types: application/json
Request Example
{ : {Configure for LDP Entropy-Label "enable": "null" none
}, : {LDP IGP configuration : {LDP IGP synchronization : {LDP IGP synchronization delay time "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}, : {MPLS mLDP configuration "enable": "null", none : {VRF Table attribute configuration for MPLS LDP : [No description {
"vrf-name": "string", VRF Name
"enable": "null", none : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
]
}, : {Global configuration for mLDP : {MPLS mLDP logging "notifications": "null" MPLS mLDP logging notifications
}
}, : {Default VRF attribute configuration for mLDP : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
}, : {Configure Discovery parameters : {LDP Targeted Hellos "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
},
"ltrace-buf-multiplier": "integer", Configure Ltrace Buffer Multiplier
range: "1..5"
default: "1" "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" : {Configure Session Backoff parameters "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
},
"disable-implicit-ipv4": "null", Disable the implicit enabling for IPv4 address\nfamily : {Configure LDP signalling parameters "dscp": "string" DSCP for control packets
}, : {Enable logging of events "nsr": "null", Configure LDP Non-Stop Routing
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}, : {Configure LDP Non-Stop Routing "enable": "null" none
}, "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Create
Create operation of resource: global
globalbody object
Request Content-Types: application/json
Request Example
{ : {Configure for LDP Entropy-Label "enable": "null" none
}, : {LDP IGP configuration : {LDP IGP synchronization : {LDP IGP synchronization delay time "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}, : {MPLS mLDP configuration "enable": "null", none : {VRF Table attribute configuration for MPLS LDP : [No description {
"vrf-name": "string", VRF Name
"enable": "null", none : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
]
}, : {Global configuration for mLDP : {MPLS mLDP logging "notifications": "null" MPLS mLDP logging notifications
}
}, : {Default VRF attribute configuration for mLDP : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
}, : {Configure Discovery parameters : {LDP Targeted Hellos "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
},
"ltrace-buf-multiplier": "integer", Configure Ltrace Buffer Multiplier
range: "1..5"
default: "1" "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" : {Configure Session Backoff parameters "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
},
"disable-implicit-ipv4": "null", Disable the implicit enabling for IPv4 address\nfamily : {Configure LDP signalling parameters "dscp": "string" DSCP for control packets
}, : {Enable logging of events "nsr": "null", Configure LDP Non-Stop Routing
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}, : {Configure LDP Non-Stop Routing "enable": "null" none
}, "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Delete
Delete operation of resource: global
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Retrieve
Retrieve operation of resource: global
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {Configure for LDP Entropy-Label "enable": "null" none
}, : {LDP IGP configuration : {LDP IGP synchronization : {LDP IGP synchronization delay time "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}, : {MPLS mLDP configuration "enable": "null", none : {VRF Table attribute configuration for MPLS LDP : [No description {
"vrf-name": "string", VRF Name
"enable": "null", none : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
]
}, : {Global configuration for mLDP : {MPLS mLDP logging "notifications": "null" MPLS mLDP logging notifications
}
}, : {Default VRF attribute configuration for mLDP : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
}, : {Configure Discovery parameters : {LDP Targeted Hellos "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
},
"ltrace-buf-multiplier": "integer", Configure Ltrace Buffer Multiplier
range: "1..5"
default: "1" "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" : {Configure Session Backoff parameters "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
},
"disable-implicit-ipv4": "null", Disable the implicit enabling for IPv4 address\nfamily : {Configure LDP signalling parameters "dscp": "string" DSCP for control packets
}, : {Enable logging of events "nsr": "null", Configure LDP Non-Stop Routing
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}, : {Configure LDP Non-Stop Routing "enable": "null" none
}, "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
}
SESSION - Update
Update operation of resource: session
sessionbody object
Request Content-Types: application/json
Request Example
{ "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" : {Configure Session Backoff parameters "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Create
Create operation of resource: session
sessionbody object
Request Content-Types: application/json
Request Example
{ "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" : {Configure Session Backoff parameters "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Delete
Delete operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" : {Configure Session Backoff parameters "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
}
}
PROTECTION - Update
Update operation of resource: protection
protectionbody object
Successful operation
Internal Error
Response Content-Types: application/json
PROTECTION - Create
Create operation of resource: protection
protectionbody object
Successful operation
Internal Error
Response Content-Types: application/json
PROTECTION - Delete
Delete operation of resource: protection
Successful operation
Internal Error
Response Content-Types: application/json
PROTECTION - Retrieve
Retrieve operation of resource: protection
Successful operation
Internal Error
DOWNSTREAM-ON-DEMAND - Update
Update operation of resource: downstream-on-demand
downstream-on-demandbody object
Successful operation
Internal Error
Response Content-Types: application/json
DOWNSTREAM-ON-DEMAND - Create
Create operation of resource: downstream-on-demand
downstream-on-demandbody object
Successful operation
Internal Error
Response Content-Types: application/json
DOWNSTREAM-ON-DEMAND - Delete
Delete operation of resource: downstream-on-demand
Successful operation
Internal Error
Response Content-Types: application/json
DOWNSTREAM-ON-DEMAND - Retrieve
Retrieve operation of resource: downstream-on-demand
Successful operation
Internal Error
NEIGHBOR - Update
Update operation of resource: neighbor
neighborbody object
Request Content-Types: application/json
Request Example
{ "password": "string", The neighbor password {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Create
Create operation of resource: neighbor
neighborbody object
Request Content-Types: application/json
Request Example
{ "password": "string", The neighbor password {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Delete
Delete operation of resource: neighbor
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "password": "string", The neighbor password {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
LDP-IDS - Update
Update operation of resource: ldp-ids
ldp-idsbody object
Request Content-Types: application/json
Request Example
{ {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LDP-IDS - Create
Create operation of resource: ldp-ids
ldp-idsbody object
Request Content-Types: application/json
Request Example
{ {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LDP-IDS - Delete
Delete operation of resource: ldp-ids
Successful operation
Internal Error
Response Content-Types: application/json
LDP-IDS - Retrieve
Retrieve operation of resource: ldp-ids
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
LDP-ID - Update
Update operation of resource: ldp-id
ldp-idbody object
ID of lsr-id label-space-id
Request Content-Types: application/json
Request Example
{ {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
LDP-ID - Create
Create operation of resource: ldp-id
ldp-idbody object
ID of lsr-id label-space-id
Request Content-Types: application/json
Request Example
{ {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
LDP-ID - Delete
Delete operation of resource: ldp-id
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
LDP-ID - Retrieve
Retrieve operation of resource: ldp-id
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
PASSWORD - Update
Update operation of resource: password
passwordbody object
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PASSWORD - Create
Create operation of resource: password
passwordbody object
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PASSWORD - Delete
Delete operation of resource: password
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PASSWORD - Retrieve
Retrieve operation of resource: password
ID of lsr-id label-space-id
Successful operation
Internal Error
DUAL-STACK - Update
Update operation of resource: dual-stack
dual-stackbody object
Request Content-Types: application/json
Request Example
{ "tlv-compliance": "null", Configuration to enable neighbor dual-stack\ntlv-compliance "max-wait": "integer", Configuration related to neighbor\ndual-stack xport-connection max-wait
range: "0..60"
units: "second" "ipv4": "null" Configuration related to neighbor\ndual-stack xport-connection preference\nipv4
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DUAL-STACK - Create
Create operation of resource: dual-stack
dual-stackbody object
Request Content-Types: application/json
Request Example
{ "tlv-compliance": "null", Configuration to enable neighbor dual-stack\ntlv-compliance "max-wait": "integer", Configuration related to neighbor\ndual-stack xport-connection max-wait
range: "0..60"
units: "second" "ipv4": "null" Configuration related to neighbor\ndual-stack xport-connection preference\nipv4
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DUAL-STACK - Delete
Delete operation of resource: dual-stack
Successful operation
Internal Error
Response Content-Types: application/json
DUAL-STACK - Retrieve
Retrieve operation of resource: dual-stack
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "tlv-compliance": "null", Configuration to enable neighbor dual-stack\ntlv-compliance "max-wait": "integer", Configuration related to neighbor\ndual-stack xport-connection max-wait
range: "0..60"
units: "second" "ipv4": "null" Configuration related to neighbor\ndual-stack xport-connection preference\nipv4
}
}
}
}
TRANSPORT-CONNECTION - Update
Update operation of resource: transport-connection
transport-connectionbody object
Request Content-Types: application/json
Request Example
{ "max-wait": "integer", Configuration related to neighbor\ndual-stack xport-connection max-wait
range: "0..60"
units: "second" "ipv4": "null" Configuration related to neighbor\ndual-stack xport-connection preference\nipv4
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-CONNECTION - Create
Create operation of resource: transport-connection
transport-connectionbody object
Request Content-Types: application/json
Request Example
{ "max-wait": "integer", Configuration related to neighbor\ndual-stack xport-connection max-wait
range: "0..60"
units: "second" "ipv4": "null" Configuration related to neighbor\ndual-stack xport-connection preference\nipv4
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-CONNECTION - Delete
Delete operation of resource: transport-connection
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-CONNECTION - Retrieve
Retrieve operation of resource: transport-connection
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "max-wait": "integer", Configuration related to neighbor\ndual-stack xport-connection max-wait
range: "0..60"
units: "second" "ipv4": "null" Configuration related to neighbor\ndual-stack xport-connection preference\nipv4
}
}
}
PREFER - Update
Update operation of resource: prefer
preferbody object
Successful operation
Internal Error
Response Content-Types: application/json
PREFER - Create
Create operation of resource: prefer
preferbody object
Successful operation
Internal Error
Response Content-Types: application/json
PREFER - Delete
Delete operation of resource: prefer
Successful operation
Internal Error
Response Content-Types: application/json
PREFER - Retrieve
Retrieve operation of resource: prefer
Successful operation
Internal Error
GRACEFUL-RESTART - Update
Update operation of resource: graceful-restart
graceful-restartbody object
Request Content-Types: application/json
Request Example
{ "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Create
Create operation of resource: graceful-restart
graceful-restartbody object
Request Content-Types: application/json
Request Example
{ "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Delete
Delete operation of resource: graceful-restart
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
HELPER-PEER - Update
Update operation of resource: helper-peer
helper-peerbody object
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-PEER - Create
Create operation of resource: helper-peer
helper-peerbody object
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-PEER - Delete
Delete operation of resource: helper-peer
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-PEER - Retrieve
Retrieve operation of resource: helper-peer
Successful operation
Internal Error
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
AFS - Update
Update operation of resource: afs
afsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
AF - Update
Update operation of resource: af
afbody object
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
DISCOVERY - Update
Update operation of resource: discovery
discoverybody object
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{ : {LDP Targeted Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Create
Create operation of resource: discovery
discoverybody object
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{ : {LDP Targeted Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Delete
Delete operation of resource: discovery
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {LDP Targeted Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
TRANSPORT-ADDRESS - Update
Update operation of resource: transport-address
transport-addressbody object
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-ADDRESS - Create
Create operation of resource: transport-address
transport-addressbody object
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-ADDRESS - Delete
Delete operation of resource: transport-address
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: transport-address
ID of interface-name
ID of af-name
Successful operation
Internal Error
IGP - Update
Update operation of resource: igp
igpbody object
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{ : {LDP IGP synchronization : {LDP IGP synchronization delay time "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Create
Create operation of resource: igp
igpbody object
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{ : {LDP IGP synchronization : {LDP IGP synchronization delay time "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Delete
Delete operation of resource: igp
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Retrieve
Retrieve operation of resource: igp
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {LDP IGP synchronization : {LDP IGP synchronization delay time "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}
}
MLDP - Update
Update operation of resource: mldp
mldpbody object
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{ "enable": "null", Enable MPLS mLDP MoFRR : {VRF Table attribute configuration for MPLS LDP : [No description {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}, : {Global configuration for mLDP : {MPLS mLDP logging "notifications": "null" MPLS mLDP logging notifications
}
}, : {Default VRF attribute configuration for mLDP : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MLDP - Create
Create operation of resource: mldp
mldpbody object
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{ "enable": "null", Enable MPLS mLDP MoFRR : {VRF Table attribute configuration for MPLS LDP : [No description {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}, : {Global configuration for mLDP : {MPLS mLDP logging "notifications": "null" MPLS mLDP logging notifications
}
}, : {Default VRF attribute configuration for mLDP : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MLDP - Delete
Delete operation of resource: mldp
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MLDP - Retrieve
Retrieve operation of resource: mldp
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "null", Enable MPLS mLDP MoFRR : {VRF Table attribute configuration for MPLS LDP : [No description {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}, : {Global configuration for mLDP : {MPLS mLDP logging "notifications": "null" MPLS mLDP logging notifications
}
}, : {Default VRF attribute configuration for mLDP : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
}
}
GLOBAL - Update
Update operation of resource: global
globalbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ : {Configure for LDP Entropy-Label "enable": "null" none
}, "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}, : {MPLS mLDP configuration "enable": "null", none : {VRF Table attribute configuration for MPLS LDP : [No description {
"vrf-name": "string", VRF Name
"enable": "null", none : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
]
}, : {Global configuration for mLDP : {MPLS mLDP logging "notifications": "null" MPLS mLDP logging notifications
}
}, : {Default VRF attribute configuration for mLDP : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
}, : {LDP Targeted Hellos "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
},
"ltrace-buf-multiplier": "integer", Configure Ltrace Buffer Multiplier
range: "1..5"
default: "1" : {LDP Session parameters "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" : {Configure Session Backoff parameters "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
},
"disable-implicit-ipv4": "null", Disable the implicit enabling for IPv4 address\nfamily : {Configure LDP signalling parameters "dscp": "string" DSCP for control packets
}, : {Enable logging of events "nsr": "null", Configure LDP Non-Stop Routing
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}, : {Configure LDP Non-Stop Routing "enable": "null" none
}, : {Configuration for LDP Graceful Restart\nparameters "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Create
Create operation of resource: global
globalbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ : {Configure for LDP Entropy-Label "enable": "null" none
}, "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}, : {MPLS mLDP configuration "enable": "null", none : {VRF Table attribute configuration for MPLS LDP : [No description {
"vrf-name": "string", VRF Name
"enable": "null", none : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
]
}, : {Global configuration for mLDP : {MPLS mLDP logging "notifications": "null" MPLS mLDP logging notifications
}
}, : {Default VRF attribute configuration for mLDP : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
}, : {LDP Targeted Hellos "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
},
"ltrace-buf-multiplier": "integer", Configure Ltrace Buffer Multiplier
range: "1..5"
default: "1" : {LDP Session parameters "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" : {Configure Session Backoff parameters "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
},
"disable-implicit-ipv4": "null", Disable the implicit enabling for IPv4 address\nfamily : {Configure LDP signalling parameters "dscp": "string" DSCP for control packets
}, : {Enable logging of events "nsr": "null", Configure LDP Non-Stop Routing
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}, : {Configure LDP Non-Stop Routing "enable": "null" none
}, : {Configuration for LDP Graceful Restart\nparameters "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Delete
Delete operation of resource: global
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Retrieve
Retrieve operation of resource: global
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {Configure for LDP Entropy-Label "enable": "null" none
}, "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}, : {MPLS mLDP configuration "enable": "null", none : {VRF Table attribute configuration for MPLS LDP : [No description {
"vrf-name": "string", VRF Name
"enable": "null", none : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
]
}, : {Global configuration for mLDP : {MPLS mLDP logging "notifications": "null" MPLS mLDP logging notifications
}
}, : {Default VRF attribute configuration for mLDP : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
}, : {LDP Targeted Hellos "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
},
"ltrace-buf-multiplier": "integer", Configure Ltrace Buffer Multiplier
range: "1..5"
default: "1" : {LDP Session parameters "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" : {Configure Session Backoff parameters "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
},
"disable-implicit-ipv4": "null", Disable the implicit enabling for IPv4 address\nfamily : {Configure LDP signalling parameters "dscp": "string" DSCP for control packets
}, : {Enable logging of events "nsr": "null", Configure LDP Non-Stop Routing
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}, : {Configure LDP Non-Stop Routing "enable": "null" none
}, : {Configuration for LDP Graceful Restart\nparameters "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
}
DISCOVERY - Update
Update operation of resource: discovery
discoverybody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ : {LDP Targeted Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Create
Create operation of resource: discovery
discoverybody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ : {LDP Targeted Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Delete
Delete operation of resource: discovery
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {LDP Targeted Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
LINK-HELLO - Update
Update operation of resource: link-hello
link-hellobody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
LINK-HELLO - Create
Create operation of resource: link-hello
link-hellobody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
LINK-HELLO - Delete
Delete operation of resource: link-hello
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
LINK-HELLO - Retrieve
Retrieve operation of resource: link-hello
ID of interface-name
Successful operation
Internal Error
IGP - Update
Update operation of resource: igp
igpbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Create
Create operation of resource: igp
igpbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Delete
Delete operation of resource: igp
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Retrieve
Retrieve operation of resource: igp
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}
}
SYNC - Update
Update operation of resource: sync
syncbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYNC - Create
Create operation of resource: sync
syncbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYNC - Delete
Delete operation of resource: sync
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SYNC - Retrieve
Retrieve operation of resource: sync
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}
DELAY - Update
Update operation of resource: delay
delaybody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Create
Create operation of resource: delay
delaybody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Delete
Delete operation of resource: delay
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Retrieve
Retrieve operation of resource: delay
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
ON-SESSION-UP - Update
Update operation of resource: on-session-up
on-session-upbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ON-SESSION-UP - Create
Create operation of resource: on-session-up
on-session-upbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ON-SESSION-UP - Delete
Delete operation of resource: on-session-up
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ON-SESSION-UP - Retrieve
Retrieve operation of resource: on-session-up
ID of interface-name
Successful operation
Internal Error
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}
GLOBAL - Update
Update operation of resource: global
globalbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ : {Configure for LDP Entropy-Label "enable": "null" none
}, : {LDP IGP configuration : {LDP IGP synchronization : {LDP IGP synchronization delay time "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}, : {MPLS mLDP configuration "enable": "null", none : {VRF Table attribute configuration for MPLS LDP : [No description {
"vrf-name": "string", VRF Name
"enable": "null", none : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
]
}, : {Global configuration for mLDP : {MPLS mLDP logging "notifications": "null" MPLS mLDP logging notifications
}
}, : {Default VRF attribute configuration for mLDP : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
}, : {Configure Discovery parameters : {LDP Targeted Hellos "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
},
"ltrace-buf-multiplier": "integer", Configure Ltrace Buffer Multiplier
range: "1..5"
default: "1" "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" : {Configure Session Backoff parameters "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
},
"disable-implicit-ipv4": "null", Disable the implicit enabling for IPv4 address\nfamily : {Configure LDP signalling parameters "dscp": "string" DSCP for control packets
}, : {Enable logging of events "nsr": "null", Configure LDP Non-Stop Routing
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}, : {Configure LDP Non-Stop Routing "enable": "null" none
}, "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Create
Create operation of resource: global
globalbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ : {Configure for LDP Entropy-Label "enable": "null" none
}, : {LDP IGP configuration : {LDP IGP synchronization : {LDP IGP synchronization delay time "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}, : {MPLS mLDP configuration "enable": "null", none : {VRF Table attribute configuration for MPLS LDP : [No description {
"vrf-name": "string", VRF Name
"enable": "null", none : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
]
}, : {Global configuration for mLDP : {MPLS mLDP logging "notifications": "null" MPLS mLDP logging notifications
}
}, : {Default VRF attribute configuration for mLDP : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
}, : {Configure Discovery parameters : {LDP Targeted Hellos "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
},
"ltrace-buf-multiplier": "integer", Configure Ltrace Buffer Multiplier
range: "1..5"
default: "1" "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" : {Configure Session Backoff parameters "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
},
"disable-implicit-ipv4": "null", Disable the implicit enabling for IPv4 address\nfamily : {Configure LDP signalling parameters "dscp": "string" DSCP for control packets
}, : {Enable logging of events "nsr": "null", Configure LDP Non-Stop Routing
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}, : {Configure LDP Non-Stop Routing "enable": "null" none
}, "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Delete
Delete operation of resource: global
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Retrieve
Retrieve operation of resource: global
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {Configure for LDP Entropy-Label "enable": "null" none
}, : {LDP IGP configuration : {LDP IGP synchronization : {LDP IGP synchronization delay time "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}, : {MPLS mLDP configuration "enable": "null", none : {VRF Table attribute configuration for MPLS LDP : [No description {
"vrf-name": "string", VRF Name
"enable": "null", none : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
]
}, : {Global configuration for mLDP : {MPLS mLDP logging "notifications": "null" MPLS mLDP logging notifications
}
}, : {Default VRF attribute configuration for mLDP : {Address Family specific operational data : [No description {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP CSC "enable": "null" none
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" none
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
}, : {Configure Discovery parameters : {LDP Targeted Hellos "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
},
"ltrace-buf-multiplier": "integer", Configure Ltrace Buffer Multiplier
range: "1..5"
default: "1" "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" : {Configure Session Backoff parameters "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
},
"disable-implicit-ipv4": "null", Disable the implicit enabling for IPv4 address\nfamily : {Configure LDP signalling parameters "dscp": "string" DSCP for control packets
}, : {Enable logging of events "nsr": "null", Configure LDP Non-Stop Routing
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}, : {Configure LDP Non-Stop Routing "enable": "null" none
}, "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
}
SESSION - Update
Update operation of resource: session
sessionbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" : {Configure Session Backoff parameters "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Create
Create operation of resource: session
sessionbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" : {Configure Session Backoff parameters "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Delete
Delete operation of resource: session
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Retrieve
Retrieve operation of resource: session
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" : {Configure Session Backoff parameters "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
}
}
DOWNSTREAM-ON-DEMAND - Update
Update operation of resource: downstream-on-demand
downstream-on-demandbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DOWNSTREAM-ON-DEMAND - Create
Create operation of resource: downstream-on-demand
downstream-on-demandbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DOWNSTREAM-ON-DEMAND - Delete
Delete operation of resource: downstream-on-demand
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DOWNSTREAM-ON-DEMAND - Retrieve
Retrieve operation of resource: downstream-on-demand
ID of vrf-name
Successful operation
Internal Error
NEIGHBOR - Update
Update operation of resource: neighbor
neighborbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "password": "string", The neighbor password {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Create
Create operation of resource: neighbor
neighborbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "password": "string", The neighbor password {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Delete
Delete operation of resource: neighbor
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "password": "string", The neighbor password {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
LDP-IDS - Update
Update operation of resource: ldp-ids
ldp-idsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LDP-IDS - Create
Create operation of resource: ldp-ids
ldp-idsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LDP-IDS - Delete
Delete operation of resource: ldp-ids
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
LDP-IDS - Retrieve
Retrieve operation of resource: ldp-ids
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
LDP-ID - Update
Update operation of resource: ldp-id
ldp-idbody object
ID of vrf-name
ID of lsr-id label-space-id
Request Content-Types: application/json
Request Example
{ {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
LDP-ID - Create
Create operation of resource: ldp-id
ldp-idbody object
ID of vrf-name
ID of lsr-id label-space-id
Request Content-Types: application/json
Request Example
{ {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
LDP-ID - Delete
Delete operation of resource: ldp-id
ID of vrf-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
LDP-ID - Retrieve
Retrieve operation of resource: ldp-id
ID of vrf-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"lsr-id": "string", LSR ID of neighbor "command-type": "string", Command type for password configuration
"password": "string" The neighbor password
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
PASSWORD - Update
Update operation of resource: password
passwordbody object
ID of vrf-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PASSWORD - Create
Create operation of resource: password
passwordbody object
ID of vrf-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PASSWORD - Delete
Delete operation of resource: password
ID of vrf-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PASSWORD - Retrieve
Retrieve operation of resource: password
ID of vrf-name
ID of lsr-id label-space-id
Successful operation
Internal Error
GRACEFUL-RESTART - Update
Update operation of resource: graceful-restart
graceful-restartbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Create
Create operation of resource: graceful-restart
graceful-restartbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Delete
Delete operation of resource: graceful-restart
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
HELPER-PEER - Update
Update operation of resource: helper-peer
helper-peerbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-PEER - Create
Create operation of resource: helper-peer
helper-peerbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-PEER - Delete
Delete operation of resource: helper-peer
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-PEER - Retrieve
Retrieve operation of resource: helper-peer
ID of vrf-name
Successful operation
Internal Error
AFS - Update
Update operation of resource: afs
afsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
AF - Update
Update operation of resource: af
afbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
DISCOVERY - Update
Update operation of resource: discovery
discoverybody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ : {LDP Targeted Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Create
Create operation of resource: discovery
discoverybody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ : {LDP Targeted Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Delete
Delete operation of resource: discovery
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {LDP Targeted Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
LABEL - Update
Update operation of resource: label
labelbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}, { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LABEL - Create
Create operation of resource: label
labelbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}, { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LABEL - Delete
Delete operation of resource: label
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
LABEL - Retrieve
Retrieve operation of resource: label
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}, { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
}
REMOTE - Update
Update operation of resource: remote
remotebody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Create
Create operation of resource: remote
remotebody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Delete
Delete operation of resource: remote
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Retrieve
Retrieve operation of resource: remote
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
}
ACCEPT - Update
Update operation of resource: accept
acceptbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ACCEPT - Create
Create operation of resource: accept
acceptbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ACCEPT - Delete
Delete operation of resource: accept
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ACCEPT - Retrieve
Retrieve operation of resource: accept
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
}
PEER-ACCEPT-POLICIES - Update
Update operation of resource: peer-accept-policies
peer-accept-policiesbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICIES - Create
Create operation of resource: peer-accept-policies
peer-accept-policiesbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICIES - Delete
Delete operation of resource: peer-accept-policies
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICIES - Retrieve
Retrieve operation of resource: peer-accept-policies
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
PEER-ACCEPT-POLICY - Update
Update operation of resource: peer-accept-policy
peer-accept-policybody object
ID of vrf-name
ID of af-name
ID of label-space-id
Request Content-Types: application/json
Request Example
{ {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY - Create
Create operation of resource: peer-accept-policy
peer-accept-policybody object
ID of vrf-name
ID of af-name
ID of label-space-id
Request Content-Types: application/json
Request Example
{ {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY - Delete
Delete operation of resource: peer-accept-policy
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY - Retrieve
Retrieve operation of resource: peer-accept-policy
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
}
PEER-ACCEPT-POLICY-DATA - Update
Update operation of resource: peer-accept-policy-data
peer-accept-policy-databody object
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY-DATA - Create
Create operation of resource: peer-accept-policy-data
peer-accept-policy-databody object
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY-DATA - Delete
Delete operation of resource: peer-accept-policy-data
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY-DATA - Retrieve
Retrieve operation of resource: peer-accept-policy-data
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
LSR-ID - Update
Update operation of resource: lsr-id
lsr-idbody object
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Successful operation
Internal Error
Response Content-Types: application/json
LSR-ID - Create
Create operation of resource: lsr-id
lsr-idbody object
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Successful operation
Internal Error
Response Content-Types: application/json
LSR-ID - Delete
Delete operation of resource: lsr-id
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Successful operation
Internal Error
Response Content-Types: application/json
LSR-ID - Retrieve
Retrieve operation of resource: lsr-id
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Successful operation
Internal Error
LOCAL - Update
Update operation of resource: local
localbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL - Create
Create operation of resource: local
localbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL - Delete
Delete operation of resource: local
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL - Retrieve
Retrieve operation of resource: local
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
},
"implicit-null-override": "string", Control use of implicit-null label for set\nof prefix(es) "prefix-acl-name": "string", Name of prefix ACL
"allocation-type": "string" Label allocation type
},
"default-route": "null" Enable MPLS forwarding for default route
}
}
ADVERTISE - Update
Update operation of resource: advertise
advertisebody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE - Create
Create operation of resource: advertise
advertisebody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE - Delete
Delete operation of resource: advertise
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE - Retrieve
Retrieve operation of resource: advertise
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string" Name of interface
}
]
},
"disable": "null", Disable label advertisement { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}, "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
}
}
PEER-ADVERTISE-POLICIES - Update
Update operation of resource: peer-advertise-policies
peer-advertise-policiesbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICIES - Create
Create operation of resource: peer-advertise-policies
peer-advertise-policiesbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICIES - Delete
Delete operation of resource: peer-advertise-policies
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICIES - Retrieve
Retrieve operation of resource: peer-advertise-policies
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
]
}
}
PEER-ADVERTISE-POLICY - Update
Update operation of resource: peer-advertise-policy
peer-advertise-policybody object
ID of vrf-name
ID of af-name
ID of label-space-id
Request Content-Types: application/json
Request Example
{ {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY - Create
Create operation of resource: peer-advertise-policy
peer-advertise-policybody object
ID of vrf-name
ID of af-name
ID of label-space-id
Request Content-Types: application/json
Request Example
{ {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY - Delete
Delete operation of resource: peer-advertise-policy
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY - Retrieve
Retrieve operation of resource: peer-advertise-policy
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"lsr-id": "string", LSR ID of neighbor
"prefix-acl-name": "string" Name of prefix ACL
}
], "prefix-acl-name": "string" Name of prefix ACL
},
"label-space-id": "integer" Label space ID of neighbor
}
}
PEER-ADVERTISE-POLICY-DATA - Update
Update operation of resource: peer-advertise-policy-data
peer-advertise-policy-databody object
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY-DATA - Create
Create operation of resource: peer-advertise-policy-data
peer-advertise-policy-databody object
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY-DATA - Delete
Delete operation of resource: peer-advertise-policy-data
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY-DATA - Retrieve
Retrieve operation of resource: peer-advertise-policy-data
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
LSR-ID - Update
Update operation of resource: lsr-id
lsr-idbody object
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Successful operation
Internal Error
Response Content-Types: application/json
LSR-ID - Create
Create operation of resource: lsr-id
lsr-idbody object
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Successful operation
Internal Error
Response Content-Types: application/json
LSR-ID - Delete
Delete operation of resource: lsr-id
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Successful operation
Internal Error
Response Content-Types: application/json
LSR-ID - Retrieve
Retrieve operation of resource: lsr-id
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Successful operation
Internal Error
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface : {Address Family specific configuration for\nMPLS LDP vrf intf : [No description {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family : {Configure interface discovery parameters : {MPLS LDP configuration for interface\ndiscovery transportaddress. "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface : {Address Family specific configuration for\nMPLS LDP vrf intf : [No description {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family : {Configure interface discovery parameters : {MPLS LDP configuration for interface\ndiscovery transportaddress. "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface : {Address Family specific configuration for\nMPLS LDP vrf intf : [No description {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family : {Configure interface discovery parameters : {MPLS LDP configuration for interface\ndiscovery transportaddress. "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of vrf-name
ID of af-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface : {Address Family specific configuration for\nMPLS LDP vrf intf : [No description {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family : {Configure interface discovery parameters : {MPLS LDP configuration for interface\ndiscovery transportaddress. "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of vrf-name
ID of af-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface : {Address Family specific configuration for\nMPLS LDP vrf intf : [No description {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family : {Configure interface discovery parameters : {MPLS LDP configuration for interface\ndiscovery transportaddress. "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of vrf-name
ID of af-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of vrf-name
ID of af-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface : {Address Family specific configuration for\nMPLS LDP vrf intf : [No description {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family : {Configure interface discovery parameters : {MPLS LDP configuration for interface\ndiscovery transportaddress. "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
EXPLICIT-NULL - Update
Update operation of resource: explicit-null
explicit-nullbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-NULL - Create
Create operation of resource: explicit-null
explicit-nullbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-NULL - Delete
Delete operation of resource: explicit-null
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-NULL - Retrieve
Retrieve operation of resource: explicit-null
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "peer-acl-name": "string", Name of peer ACL
"explicit-null-type": "string", Explicit Null command variant
"prefix-acl-name": "string" Name of prefix ACL
}
}
ALLOCATE - Update
Update operation of resource: allocate
allocatebody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ALLOCATE - Create
Create operation of resource: allocate
allocatebody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ALLOCATE - Delete
Delete operation of resource: allocate
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ALLOCATE - Retrieve
Retrieve operation of resource: allocate
ID of vrf-name
ID of af-name
Successful operation
Internal Error
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": "null", Enable Address Family
"interface-name": "string", Name of interface {
"af-name": "string", Address Family name
"enable": "null", Enable Address Family "address-type": "string", Transport address option
"address": "string" IP address
}
}
}
]
}
}
]
}
AFS - Update
Update operation of resource: afs
afsbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
AF - Update
Update operation of resource: af
afbody object
ID of vrf-name
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of vrf-name
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR : {MLDP neighbor policies : [No description {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, : {Enable recursive forwarding "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP CSC "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name : {MPLS mLDP Make-Before-Break configuration "policy": "string", Route policy name : {Enable MPLS mLDP MBB signaling "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, : {MPLS mLDP Recursive FEC "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, : {MPLS mLDP MoFRR "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
DISCOVERY - Update
Update operation of resource: discovery
discoverybody object
ID of vrf-name
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{ : {LDP Targeted Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Create
Create operation of resource: discovery
discoverybody object
ID of vrf-name
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{ : {LDP Targeted Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Delete
Delete operation of resource: discovery
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {LDP Targeted Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode : {LDP Link Hellos "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
TRANSPORT-ADDRESS - Update
Update operation of resource: transport-address
transport-addressbody object
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-ADDRESS - Create
Create operation of resource: transport-address
transport-addressbody object
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-ADDRESS - Delete
Delete operation of resource: transport-address
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: transport-address
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
GLOBAL - Update
Update operation of resource: global
globalbody object
Request Content-Types: application/json
Request Example
{ "enable": "null" none
}, "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}, "enable": "null", none {
"vrf-name": "string", VRF Name
"enable": "null", none {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" none
}, "enable": "null" none
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" none
}, "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
]
}, "notifications": "null" MPLS mLDP logging notifications
}
}, {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" none
}, "enable": "null" none
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" none
}, "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
}, "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
},
"ltrace-buf-multiplier": "integer", Configure Ltrace Buffer Multiplier
range: "1..5"
default: "1" "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
},
"disable-implicit-ipv4": "null", Disable the implicit enabling for IPv4 address\nfamily "dscp": "string" DSCP for control packets
}, "nsr": "null", Configure LDP Non-Stop Routing
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}, "enable": "null" none
}, "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Create
Create operation of resource: global
globalbody object
Request Content-Types: application/json
Request Example
{ "enable": "null" none
}, "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}, "enable": "null", none {
"vrf-name": "string", VRF Name
"enable": "null", none {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" none
}, "enable": "null" none
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" none
}, "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
]
}, "notifications": "null" MPLS mLDP logging notifications
}
}, {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" none
}, "enable": "null" none
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" none
}, "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
}, "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
},
"ltrace-buf-multiplier": "integer", Configure Ltrace Buffer Multiplier
range: "1..5"
default: "1" "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
},
"disable-implicit-ipv4": "null", Disable the implicit enabling for IPv4 address\nfamily "dscp": "string" DSCP for control packets
}, "nsr": "null", Configure LDP Non-Stop Routing
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}, "enable": "null" none
}, "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Delete
Delete operation of resource: global
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Retrieve
Retrieve operation of resource: global
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "null" none
}, "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}, "enable": "null", none {
"vrf-name": "string", VRF Name
"enable": "null", none {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" none
}, "enable": "null" none
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" none
}, "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
]
}, "notifications": "null" MPLS mLDP logging notifications
}
}, {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", none {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" none
}, "enable": "null" none
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" none
}, "policy": "string", Route policy name
"enable": "null" none
}
}
]
}
}
}, "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode "hold-time": "string", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
},
"ltrace-buf-multiplier": "integer", Configure Ltrace Buffer Multiplier
range: "1..5"
default: "1" "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
},
"disable-implicit-ipv4": "null", Disable the implicit enabling for IPv4 address\nfamily "dscp": "string" DSCP for control packets
}, "nsr": "null", Configure LDP Non-Stop Routing
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}, "enable": "null" none
}, "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
}
ENTROPY-LABEL - Update
Update operation of resource: entropy-label
entropy-labelbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENTROPY-LABEL - Create
Create operation of resource: entropy-label
entropy-labelbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENTROPY-LABEL - Delete
Delete operation of resource: entropy-label
Successful operation
Internal Error
Response Content-Types: application/json
ENTROPY-LABEL - Retrieve
Retrieve operation of resource: entropy-label
Successful operation
Internal Error
SESSION - Update
Update operation of resource: session
sessionbody object
Request Content-Types: application/json
Request Example
{ "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Create
Create operation of resource: session
sessionbody object
Request Content-Types: application/json
Request Example
{ "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Delete
Delete operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hold-time": "integer", LDP Session holdtime
range: "15..65535"
units: "second"
default: "180" "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
}
}
BACKOFF-TIME - Update
Update operation of resource: backoff-time
backoff-timebody object
Request Content-Types: application/json
Request Example
{ "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BACKOFF-TIME - Create
Create operation of resource: backoff-time
backoff-timebody object
Request Content-Types: application/json
Request Example
{ "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BACKOFF-TIME - Delete
Delete operation of resource: backoff-time
Successful operation
Internal Error
Response Content-Types: application/json
BACKOFF-TIME - Retrieve
Retrieve operation of resource: backoff-time
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "max-backoff-time": "integer", Maximum session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "120"
"initial-backoff-time": "integer" Initial session backoff time (seconds)
range: "5..2147483"
units: "second"
default: "15"
}
}
IGP - Update
Update operation of resource: igp
igpbody object
Request Content-Types: application/json
Request Example
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Create
Create operation of resource: igp
igpbody object
Request Content-Types: application/json
Request Example
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Delete
Delete operation of resource: igp
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Retrieve
Retrieve operation of resource: igp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}
}
SYNC - Update
Update operation of resource: sync
syncbody object
Request Content-Types: application/json
Request Example
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYNC - Create
Create operation of resource: sync
syncbody object
Request Content-Types: application/json
Request Example
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYNC - Delete
Delete operation of resource: sync
Successful operation
Internal Error
Response Content-Types: application/json
SYNC - Retrieve
Retrieve operation of resource: sync
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
}
DELAY - Update
Update operation of resource: delay
delaybody object
Request Content-Types: application/json
Request Example
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Create
Create operation of resource: delay
delaybody object
Request Content-Types: application/json
Request Example
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Delete
Delete operation of resource: delay
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Retrieve
Retrieve operation of resource: delay
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "on-proc-restart": "integer", Global sync up delay to be used after\nprocess restart
range: "60..600"
units: "second"
"on-session-up": "integer" Interface sync up delay after session up
range: "5..300"
units: "second"
}
}
ENABLE-LOGGING - Update
Update operation of resource: enable-logging
enable-loggingbody object
Request Content-Types: application/json
Request Example
{ "nsr": "null", Enable logging of NSR events
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENABLE-LOGGING - Create
Create operation of resource: enable-logging
enable-loggingbody object
Request Content-Types: application/json
Request Example
{ "nsr": "null", Enable logging of NSR events
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENABLE-LOGGING - Delete
Delete operation of resource: enable-logging
Successful operation
Internal Error
Response Content-Types: application/json
ENABLE-LOGGING - Retrieve
Retrieve operation of resource: enable-logging
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "nsr": "null", Enable logging of NSR events
"adjacency": "null", Enable logging of adjacency events
"session-protection": "null", Enable logging of session protection events
"neighbor-changes": "null", Enable logging of neighbor events
"gr-session-changes": "null" Enable logging of Graceful Restart (GR) events
}
}
SIGNALLING - Update
Update operation of resource: signalling
signallingbody object
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALLING - Create
Create operation of resource: signalling
signallingbody object
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALLING - Delete
Delete operation of resource: signalling
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALLING - Retrieve
Retrieve operation of resource: signalling
Successful operation
Internal Error
NSR - Update
Update operation of resource: nsr
nsrbody object
Successful operation
Internal Error
Response Content-Types: application/json
NSR - Create
Create operation of resource: nsr
nsrbody object
Successful operation
Internal Error
Response Content-Types: application/json
NSR - Delete
Delete operation of resource: nsr
Successful operation
Internal Error
Response Content-Types: application/json
NSR - Retrieve
Retrieve operation of resource: nsr
Successful operation
Internal Error
GRACEFUL-RESTART - Update
Update operation of resource: graceful-restart
graceful-restartbody object
Request Content-Types: application/json
Request Example
{ "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Create
Create operation of resource: graceful-restart
graceful-restartbody object
Request Content-Types: application/json
Request Example
{ "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Delete
Delete operation of resource: graceful-restart
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "reconnect-timeout": "integer", Configure Graceful Restart Reconnect Timeout\nvalue
range: "60..1800"
units: "second"
default: "120"
"enable": "null", none
"forwarding-hold-time": "integer" Configure Graceful Restart Session holdtime
range: "60..1800"
units: "second"
default: "180"
}
}
DISCOVERY - Update
Update operation of resource: discovery
discoverybody object
Request Content-Types: application/json
Request Example
{ "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Create
Create operation of resource: discovery
discoverybody object
Request Content-Types: application/json
Request Example
{ "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Delete
Delete operation of resource: discovery
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-quick-start": "null", Disable discovery's quick start mode "hold-time": "string", Time (seconds) - 65535 implies infinite
range: "15..65535"
units: "second"
default: "180"
"interval": "string" Link Hello interval
units: "minute"
},
"disable-instance-tlv": "null" Disable transmit and receive processing for\nprivate Instance TLV in LDP discovery hello\nmessages
}
}
LINK-HELLO - Update
Update operation of resource: link-hello
link-hellobody object
Successful operation
Internal Error
Response Content-Types: application/json
LINK-HELLO - Create
Create operation of resource: link-hello
link-hellobody object
Successful operation
Internal Error
Response Content-Types: application/json
LINK-HELLO - Delete
Delete operation of resource: link-hello
Successful operation
Internal Error
Response Content-Types: application/json
LINK-HELLO - Retrieve
Retrieve operation of resource: link-hello
Successful operation
Internal Error
TARGETED-HELLO - Update
Update operation of resource: targeted-hello
targeted-hellobody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGETED-HELLO - Create
Create operation of resource: targeted-hello
targeted-hellobody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGETED-HELLO - Delete
Delete operation of resource: targeted-hello
Successful operation
Internal Error
Response Content-Types: application/json
TARGETED-HELLO - Retrieve
Retrieve operation of resource: targeted-hello
Successful operation
Internal Error
MLDP - Update
Update operation of resource: mldp
mldpbody object
Request Content-Types: application/json
Request Example
{ "enable": "null", Enable MPLS mLDP MoFRR {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}, "notifications": "null" MPLS mLDP logging notifications
}
}, {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MLDP - Create
Create operation of resource: mldp
mldpbody object
Request Content-Types: application/json
Request Example
{ "enable": "null", Enable MPLS mLDP MoFRR {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}, "notifications": "null" MPLS mLDP logging notifications
}
}, {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MLDP - Delete
Delete operation of resource: mldp
Successful operation
Internal Error
Response Content-Types: application/json
MLDP - Retrieve
Retrieve operation of resource: mldp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "null", Enable MPLS mLDP MoFRR {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}, "notifications": "null" MPLS mLDP logging notifications
}
}, {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
}
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF Name
"enable": "null", Enable MPLS mLDP MoFRR {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
]
}
AFS - Update
Update operation of resource: afs
afsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
AF - Update
Update operation of resource: af
afbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
RECURSIVE-FORWARDING - Update
Update operation of resource: recursive-forwarding
recursive-forwardingbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
RECURSIVE-FORWARDING - Create
Create operation of resource: recursive-forwarding
recursive-forwardingbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
RECURSIVE-FORWARDING - Delete
Delete operation of resource: recursive-forwarding
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
RECURSIVE-FORWARDING - Retrieve
Retrieve operation of resource: recursive-forwarding
ID of vrf-name
ID of af-name
Successful operation
Internal Error
MLDP-RECURSIVE-FEC - Update
Update operation of resource: mldp-recursive-fec
mldp-recursive-fecbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-RECURSIVE-FEC - Create
Create operation of resource: mldp-recursive-fec
mldp-recursive-fecbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-RECURSIVE-FEC - Delete
Delete operation of resource: mldp-recursive-fec
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-RECURSIVE-FEC - Retrieve
Retrieve operation of resource: mldp-recursive-fec
ID of vrf-name
ID of af-name
Successful operation
Internal Error
NEIGHBOR-POLICIES - Update
Update operation of resource: neighbor-policies
neighbor-policiesbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICIES - Create
Create operation of resource: neighbor-policies
neighbor-policiesbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICIES - Delete
Delete operation of resource: neighbor-policies
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICIES - Retrieve
Retrieve operation of resource: neighbor-policies
ID of vrf-name
ID of af-name
Successful operation
Internal Error
NEIGHBOR-POLICY - Update
Update operation of resource: neighbor-policy
neighbor-policybody object
ID of vrf-name
ID of af-name
ID of root-address policy-mode
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICY - Create
Create operation of resource: neighbor-policy
neighbor-policybody object
ID of vrf-name
ID of af-name
ID of root-address policy-mode
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICY - Delete
Delete operation of resource: neighbor-policy
ID of vrf-name
ID of af-name
ID of root-address policy-mode
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICY - Retrieve
Retrieve operation of resource: neighbor-policy
ID of vrf-name
ID of af-name
ID of root-address policy-mode
Successful operation
Internal Error
MO-FRR - Update
Update operation of resource: mo-frr
mo-frrbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MO-FRR - Create
Create operation of resource: mo-frr
mo-frrbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MO-FRR - Delete
Delete operation of resource: mo-frr
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MO-FRR - Retrieve
Retrieve operation of resource: mo-frr
ID of vrf-name
ID of af-name
Successful operation
Internal Error
MAKE-BEFORE-BREAK - Update
Update operation of resource: make-before-break
make-before-breakbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAKE-BEFORE-BREAK - Create
Create operation of resource: make-before-break
make-before-breakbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAKE-BEFORE-BREAK - Delete
Delete operation of resource: make-before-break
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MAKE-BEFORE-BREAK - Retrieve
Retrieve operation of resource: make-before-break
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}
}
SIGNALING - Update
Update operation of resource: signaling
signalingbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALING - Create
Create operation of resource: signaling
signalingbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALING - Delete
Delete operation of resource: signaling
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALING - Retrieve
Retrieve operation of resource: signaling
ID of vrf-name
ID of af-name
Successful operation
Internal Error
CSC - Update
Update operation of resource: csc
cscbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
CSC - Create
Create operation of resource: csc
cscbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
CSC - Delete
Delete operation of resource: csc
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
CSC - Retrieve
Retrieve operation of resource: csc
ID of vrf-name
ID of af-name
Successful operation
Internal Error
DEFAULT-VRF - Update
Update operation of resource: default-vrf
default-vrfbody object
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Create
Create operation of resource: default-vrf
default-vrfbody object
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Delete
Delete operation of resource: default-vrf
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Retrieve
Retrieve operation of resource: default-vrf
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
}
AFS - Update
Update operation of resource: afs
afsbody object
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
}
AF - Update
Update operation of resource: af
afbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": "null", Enable MPLS MLDP RIB unicast-always\nconfiguration
"enable": "null", Enable MPLS mLDP MoFRR {
"route-policy": "string", Route policy name
"root-address": "string", Neighbor Address
"policy-mode": "string" Inbound/Outbound Policy
}
]
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "enable": "null" Enable MPLS mLDP MoFRR
},
"af-name": "string", Address Family name "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}, "policy": "string", Route policy name
"enable": "null" Enable MPLS mLDP MoFRR
}
}
]
}
RECURSIVE-FORWARDING - Update
Update operation of resource: recursive-forwarding
recursive-forwardingbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
RECURSIVE-FORWARDING - Create
Create operation of resource: recursive-forwarding
recursive-forwardingbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
RECURSIVE-FORWARDING - Delete
Delete operation of resource: recursive-forwarding
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
RECURSIVE-FORWARDING - Retrieve
Retrieve operation of resource: recursive-forwarding
ID of af-name
Successful operation
Internal Error
MLDP-RECURSIVE-FEC - Update
Update operation of resource: mldp-recursive-fec
mldp-recursive-fecbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-RECURSIVE-FEC - Create
Create operation of resource: mldp-recursive-fec
mldp-recursive-fecbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-RECURSIVE-FEC - Delete
Delete operation of resource: mldp-recursive-fec
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-RECURSIVE-FEC - Retrieve
Retrieve operation of resource: mldp-recursive-fec
ID of af-name
Successful operation
Internal Error
NEIGHBOR-POLICIES - Update
Update operation of resource: neighbor-policies
neighbor-policiesbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICIES - Create
Create operation of resource: neighbor-policies
neighbor-policiesbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICIES - Delete
Delete operation of resource: neighbor-policies
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICIES - Retrieve
Retrieve operation of resource: neighbor-policies
ID of af-name
Successful operation
Internal Error
NEIGHBOR-POLICY - Update
Update operation of resource: neighbor-policy
neighbor-policybody object
ID of af-name
ID of root-address policy-mode
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICY - Create
Create operation of resource: neighbor-policy
neighbor-policybody object
ID of af-name
ID of root-address policy-mode
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICY - Delete
Delete operation of resource: neighbor-policy
ID of af-name
ID of root-address policy-mode
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICY - Retrieve
Retrieve operation of resource: neighbor-policy
ID of af-name
ID of root-address policy-mode
Successful operation
Internal Error
MO-FRR - Update
Update operation of resource: mo-frr
mo-frrbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MO-FRR - Create
Create operation of resource: mo-frr
mo-frrbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MO-FRR - Delete
Delete operation of resource: mo-frr
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MO-FRR - Retrieve
Retrieve operation of resource: mo-frr
ID of af-name
Successful operation
Internal Error
MAKE-BEFORE-BREAK - Update
Update operation of resource: make-before-break
make-before-breakbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAKE-BEFORE-BREAK - Create
Create operation of resource: make-before-break
make-before-breakbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAKE-BEFORE-BREAK - Delete
Delete operation of resource: make-before-break
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MAKE-BEFORE-BREAK - Retrieve
Retrieve operation of resource: make-before-break
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "policy": "string", Route policy name "forward-delay": "integer", Forwarding Delay in Seconds
range: "0..600"
units: "second"
"delete-delay": "integer" Delete Delay in seconds
range: "0..60"
units: "second"
}
}
}
SIGNALING - Update
Update operation of resource: signaling
signalingbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALING - Create
Create operation of resource: signaling
signalingbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALING - Delete
Delete operation of resource: signaling
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALING - Retrieve
Retrieve operation of resource: signaling
ID of af-name
Successful operation
Internal Error
CSC - Update
Update operation of resource: csc
cscbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
CSC - Create
Create operation of resource: csc
cscbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
CSC - Delete
Delete operation of resource: csc
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
CSC - Retrieve
Retrieve operation of resource: csc
ID of af-name
Successful operation
Internal Error
MLDP-GLOBAL - Update
Update operation of resource: mldp-global
mldp-globalbody object
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-GLOBAL - Create
Create operation of resource: mldp-global
mldp-globalbody object
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-GLOBAL - Delete
Delete operation of resource: mldp-global
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-GLOBAL - Retrieve
Retrieve operation of resource: mldp-global
LOGGING - Update
Update operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Create
Create operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Delete
Delete operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Retrieve
Retrieve operation of resource: logging
Successful operation
Internal Error
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
ENCRYPTED-COMMUNITY-MAPS - Update
Update operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Create
Create operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Delete
Delete operation of resource: encrypted-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: encrypted-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
ENCRYPTED-COMMUNITY-MAP - Update
Update operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Create
Create operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Delete
Delete operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
VIEWS - Update
Update operation of resource: views
viewsbody object
Request Content-Types: application/json
Request Example
{ {
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Create
Create operation of resource: views
viewsbody object
Request Content-Types: application/json
Request Example
{ {
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Delete
Delete operation of resource: views
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Retrieve
Retrieve operation of resource: views
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
}
]
}
}
VIEW - Update
Update operation of resource: view
viewbody object
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Create
Create operation of resource: view
viewbody object
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Delete
Delete operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Retrieve
Retrieve operation of resource: view
ID of view-name family
Successful operation
Internal Error
LOGGING - Update
Update operation of resource: logging
loggingbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Create
Create operation of resource: logging
loggingbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Delete
Delete operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Retrieve
Retrieve operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
ADMINISTRATION - Update
Update operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}, {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Create
Create operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}, {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Delete
Delete operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Retrieve
Retrieve operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}, {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
}
DEFAULT-COMMUNITIES - Update
Update operation of resource: default-communities
default-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Create
Create operation of resource: default-communities
default-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Delete
Delete operation of resource: default-communities
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Retrieve
Retrieve operation of resource: default-communities
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
DEFAULT-COMMUNITY - Update
Update operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Create
Create operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Delete
Delete operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Retrieve
Retrieve operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
ENCRYPTED-COMMUNITIES - Update
Update operation of resource: encrypted-communities
encrypted-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Create
Create operation of resource: encrypted-communities
encrypted-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Delete
Delete operation of resource: encrypted-communities
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-communities
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
ENCRYPTED-COMMUNITY - Update
Update operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Create
Create operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Delete
Delete operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
AGENT - Update
Update operation of resource: agent
agentbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Create
Create operation of resource: agent
agentbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Delete
Delete operation of resource: agent
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Retrieve
Retrieve operation of resource: agent
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
}
ENGINE-ID - Update
Update operation of resource: engine-id
engine-idbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Create
Create operation of resource: engine-id
engine-idbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Delete
Delete operation of resource: engine-id
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Retrieve
Retrieve operation of resource: engine-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
REMOTES - Update
Update operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Create
Create operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Delete
Delete operation of resource: remotes
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Retrieve
Retrieve operation of resource: remotes
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
}
}
REMOTE - Update
Update operation of resource: remote
remotebody object
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Create
Create operation of resource: remote
remotebody object
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Delete
Delete operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Retrieve
Retrieve operation of resource: remote
ID of remote-address
Successful operation
Internal Error
TRAP - Update
Update operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{ "queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Create
Create operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{ "queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Delete
Delete operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Retrieve
Retrieve operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "second"
}
}
DROP-PACKET - Update
Update operation of resource: drop-packet
drop-packetbody object
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Create
Create operation of resource: drop-packet
drop-packetbody object
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Delete
Delete operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Retrieve
Retrieve operation of resource: drop-packet
Successful operation
Internal Error
IPV6 - Update
Update operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Create
Create operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Delete
Delete operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Retrieve
Retrieve operation of resource: ipv6
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
SYSTEM - Update
Update operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{ "chassis-id": "string", String to uniquely identify this chassis
"contact": "string", identification of the contact person for this\nmanaged node
"location": "string" The physical location of this node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Create
Create operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{ "chassis-id": "string", String to uniquely identify this chassis
"contact": "string", identification of the contact person for this\nmanaged node
"location": "string" The physical location of this node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Delete
Delete operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Retrieve
Retrieve operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "chassis-id": "string", String to uniquely identify this chassis
"contact": "string", identification of the contact person for this\nmanaged node
"location": "string" The physical location of this node
}
}
TARGET - Update
Update operation of resource: target
targetbody object
Request Content-Types: application/json
Request Example
{ : {SNMP Target address configurations : [No description {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list : {List of VRF Name for a target list : [No description {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
Request Content-Types: application/json
Request Example
{ : {SNMP Target address configurations : [No description {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list : {List of VRF Name for a target list : [No description {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {SNMP Target address configurations : [No description {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list : {List of VRF Name for a target list : [No description {
"name": "string" VRF Name
}
]
}
}
}
TARGETS - Update
Update operation of resource: targets
targetsbody object
Request Content-Types: application/json
Request Example
{ { {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Create
Create operation of resource: targets
targetsbody object
Request Content-Types: application/json
Request Example
{ { {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Delete
Delete operation of resource: targets
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Retrieve
Retrieve operation of resource: targets
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
]
}
}
TARGET - Update
Update operation of resource: target
targetbody object
ID of target-list-name
Request Content-Types: application/json
Request Example
{ {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of target-list-name
Request Content-Types: application/json
Request Example
{ {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
}
VRF-NAMES - Update
Update operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Create
Create operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Delete
Delete operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Retrieve
Retrieve operation of resource: vrf-names
ID of target-list-name
VRF-NAME - Update
Update operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Create
Create operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Delete
Delete operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Retrieve
Retrieve operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
TARGET-ADDRESSES - Update
Update operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Create
Create operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Delete
Delete operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Retrieve
Retrieve operation of resource: target-addresses
ID of target-list-name
TARGET-ADDRESS - Update
Update operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Create
Create operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Delete
Delete operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
NOTIFICATION - Update
Update operation of resource: notification
notificationbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}, "session-up": "null", Enable mplsLdpSessionUp notification
"session-down": "null", Enable mplsLdpSessionDown notification
"init-session-threshold-exceeded": "null" Enable mplsLdpInitSessionThresholdExceeded\nnotification
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Create
Create operation of resource: notification
notificationbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}, "session-up": "null", Enable mplsLdpSessionUp notification
"session-down": "null", Enable mplsLdpSessionDown notification
"init-session-threshold-exceeded": "null" Enable mplsLdpInitSessionThresholdExceeded\nnotification
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Delete
Delete operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Retrieve
Retrieve operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}, "session-up": "null", Enable mplsLdpSessionUp notification
"session-down": "null", Enable mplsLdpSessionDown notification
"init-session-threshold-exceeded": "null" Enable mplsLdpInitSessionThresholdExceeded\nnotification
}
}
}
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
MPLS-LDP - Update
Update operation of resource: mpls-ldp
mpls-ldpbody object
Request Content-Types: application/json
Request Example
{ "session-up": "null", Enable mplsLdpSessionUp notification
"session-down": "null", Enable mplsLdpSessionDown notification
"init-session-threshold-exceeded": "null" Enable mplsLdpInitSessionThresholdExceeded\nnotification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LDP - Create
Create operation of resource: mpls-ldp
mpls-ldpbody object
Request Content-Types: application/json
Request Example
{ "session-up": "null", Enable mplsLdpSessionUp notification
"session-down": "null", Enable mplsLdpSessionDown notification
"init-session-threshold-exceeded": "null" Enable mplsLdpInitSessionThresholdExceeded\nnotification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LDP - Delete
Delete operation of resource: mpls-ldp
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LDP - Retrieve
Retrieve operation of resource: mpls-ldp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "session-up": "null", Enable mplsLdpSessionUp notification
"session-down": "null", Enable mplsLdpSessionDown notification
"init-session-threshold-exceeded": "null" Enable mplsLdpInitSessionThresholdExceeded\nnotification
}
}
CORRELATOR - Update
Update operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "second"
"name": "string" Ruleset name
}
]
}, { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
},
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Create
Create operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "second"
"name": "string" Ruleset name
}
]
}, { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
},
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Delete
Delete operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Retrieve
Retrieve operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "second"
"name": "string" Ruleset name
}
]
}, { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
},
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"
}
}
RULES - Update
Update operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "second"
"name": "string" Rule name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Create
Create operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "second"
"name": "string" Rule name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Delete
Delete operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Retrieve
Retrieve operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "second"
"name": "string" Rule name
}
]
}
}
RULE - Update
Update operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "second"
"name": "string" Rule name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Create
Create operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "second"
"name": "string" Rule name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Delete
Delete operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Retrieve
Retrieve operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "second"
"name": "string" Rule name
}
]
}
ROOT-CAUSES - Update
Update operation of resource: root-causes
root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Create
Create operation of resource: root-causes
root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Delete
Delete operation of resource: root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Retrieve
Retrieve operation of resource: root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
}
ROOT-CAUSE - Update
Update operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Create
Create operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Delete
Delete operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Retrieve
Retrieve operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
NON-ROOT-CAUSES - Update
Update operation of resource: non-root-causes
non-root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Create
Create operation of resource: non-root-causes
non-root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Delete
Delete operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Retrieve
Retrieve operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
}
NON-ROOT-CAUSE - Update
Update operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Create
Create operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Delete
Delete operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Retrieve
Retrieve operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
RULE-SETS - Update
Update operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Create
Create operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Delete
Delete operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Retrieve
Retrieve operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
}
RULE-SET - Update
Update operation of resource: rule-set
rule-setbody object
ID of name
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Create
Create operation of resource: rule-set
rule-setbody object
ID of name
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Delete
Delete operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Retrieve
Retrieve operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
RULENAMES - Update
Update operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Create
Create operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Delete
Delete operation of resource: rulenames
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Retrieve
Retrieve operation of resource: rulenames
ID of name
RULENAME - Update
Update operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Create
Create operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Delete
Delete operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Retrieve
Retrieve operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
BULK-STATS - Update
Update operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{ "memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte" {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" The name of the schema
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure schema name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}, {
"object-list-name": "string", Name of the object List {
"oid": "string" Object name or OID
}
]
},
"type": "null" Configure schema name
}
]
}, {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Create
Create operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{ "memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte" {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" The name of the schema
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure schema name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}, {
"object-list-name": "string", Name of the object List {
"oid": "string" Object name or OID
}
]
},
"type": "null" Configure schema name
}
]
}, {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Delete
Delete operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Retrieve
Retrieve operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte" {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" The name of the schema
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure schema name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}, {
"object-list-name": "string", Name of the object List {
"oid": "string" Object name or OID
}
]
},
"type": "null" Configure schema name
}
]
}, {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
}
SCHEMAS - Update
Update operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Create
Create operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Delete
Delete operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Retrieve
Retrieve operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
SCHEMA - Update
Update operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Create
Create operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Delete
Delete operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Retrieve
Retrieve operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
INSTANCE - Update
Update operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Type of the instance
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Create
Create operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Type of the instance
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Delete
Delete operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Retrieve
Retrieve operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Type of the instance
}
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
Successful operation
Internal Error
OBJECTS - Update
Update operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
ID of object-list-name
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
TRANSFERS - Update
Update operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Create
Create operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Delete
Delete operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Retrieve
Retrieve operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
}
TRANSFER - Update
Update operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Create
Create operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Delete
Delete operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Retrieve
Retrieve operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
TRANSFER-SCHEMAS - Update
Update operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Create
Create operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Delete
Delete operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Retrieve
Retrieve operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
TRANSFER-SCHEMA - Update
Update operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Create
Create operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Delete
Delete operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Retrieve
Retrieve operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
DEFAULT-COMMUNITY-MAPS - Update
Update operation of resource: default-community-maps
default-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Create
Create operation of resource: default-community-maps
default-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Delete
Delete operation of resource: default-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: default-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
DEFAULT-COMMUNITY-MAP - Update
Update operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Create
Create operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Delete
Delete operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
OVERLOAD-CONTROL - Update
Update operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{ "drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Create
Create operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{ "drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Delete
Delete operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Retrieve
Retrieve operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"
}
}
TIMEOUTS - Update
Update operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{ "duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Create
Create operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{ "duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Delete
Delete operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Retrieve
Retrieve operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"
}
}
USERS - Update
Update operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Create
Create operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Delete
Delete operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Retrieve
Retrieve operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
}
USER - Update
Update operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Create
Create operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Delete
Delete operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
USER - Retrieve
Retrieve operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
ID of name
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
GROUPS - Update
Update operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Create
Create operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Delete
Delete operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Retrieve
Retrieve operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
}
GROUP - Update
Update operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Create
Create operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Delete
Delete operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Retrieve
Retrieve operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of context-name
Successful operation
Internal Error
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
MIB - Update
Update operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Create
Create operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Delete
Delete operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Retrieve
Retrieve operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{